This section describes how to upgrade from FormFix 4 to FormFix 5. While generally you'll be able to replace FormFix 4 with FormFix 5, there are a few important changes you may need to consider. This section provides information about those changes.
Changes and New Properties/Methods
FormFix 5 introduces changes to its API as described in this section.
The following is a guide to make the upgrade as smooth as possible.
Required Changes
Licensing
- The FormFix runtime licensing scheme is changed completely in V5, but you can replace the existing with at most 3 lines of code. See Upgrading Runtime Licensing for code examples.
- The following API has been removed from V5, so any code reference to it needs to be removed.
Accusoft.FormFix.Licensing.LicenseEdition property
Removal of Previously Deprecated Items
- The property OMRProcessor.OriginOfClip, which was deprecated in FormFix 4, has been removed in V5.
Recommended Changes
Image Transfer
There are several different ways to import and export image data into the FormFix class. In V5, we have provided new interfaces for image transfer between ScanFix Xpress and other applicable Accusoft components. These new methods are recommended for their ease of use and to prevent memory leaks.
Export
void FormImage.CopyTo(System.Object Destination);
void FormImage.TransferTo(System.Object Destination);
Import
Importing image data to a FormImage object is achieved by passing a FormImage object as the input of the same export methods called by another Accusoft object.
 |
The FormImage object has to be instantiated before being passed in. |
New OMR
FormFix 5 introduces changes to the API's functioning as described in this section.
- A new mechanism for OMR processing, which is set using the new OmrProcessor.RecognitionEngine property.
- When RecognitionEngine is set to RecognitionEngine.SingleThresold, the new mechanism for OMR processing is used.
- When RecognitionEngine is set to RecognitionEngine.DualThresholdLegacy, the older way is used.
- The new SingleThreshold engine is intended to simplify the use of OMR and is recommended over the DualThresholdLegacy engine.
New OMR Processing Mechanism
- If all marks are above threshold and there are no segments with too many marks, the behavior will be what was seen in FormFix 4. The improvements are to cases outside this range, and are as follows:
- In a Single Bubble segment, the confidence values will reflect the degree to which the bubbles are marked.
- In a Multiple Bubbles Single Mark Allowed segment, a marked result will *not* be returned if the mark density is below threshold. Also, if multiple bubbles are marked above threshold, the string stored in the new property TooManyMarksSegmentResult is returned.
- In a Multiple Bubbles Multiple Marks Allowed segment, a marked result will *not* be returned if the mark density is below threshold. Also, if all bubbles are marked with densities that are close to each other with some above threshold, only those above the threshold will be returned as marked.
- Added the following new properties:
Deprecated
As part of the change for the new OMR mechanism, the following have been deprecated:
- the OmrProcessor.Area property.
- the OMRAnalysisComparisonMethod.CompareFullImageToFormModel enum value.
- the OMRProcessor.MarkedBubbleThreshold and OMRProcessor.UnmarkedBubbleThreshold properties.
If you encounter any porting issues, please contact support@accusoft.com for assistance.
